Vapi Std LocalizableMessage

Vapi Std LocalizableMessage
Vapi Std LocalizableMessage

The Vapi Std LocalizableMessage schema represents localizable string and message template. Resources include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Resources can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

JSON Example
{
    "id": "string",
    "default_message": "string",
    "args": [
        "string"
    ],
    "params": {
        "params": {
            "s": "string",
            "dt": "string",
            "i": 0,
            "d": "number",
            "l": "Vapi Std NestedLocalizableMessage Object",
            "format": "string",
            "precision": 0
        }
    },
    "localized": "string"
}
string
id
Required

Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

string
default_message
Required

The value of this localizable string or message template in the en_US (English) locale. If Vapi Std LocalizableMessage.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

array of string
args
Required

Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

object
params
Optional

Named arguments to be substituted into the message template.

This property was added in vSphere API 7.0.0.0.

Missing or null means that the message template requires no arguments or positional arguments are used.

string
localized
Optional

Localized string value as per request requirements.

This property was added in vSphere API 7.0.0.0.

when the client has not requested specific locale the implementation may not populate this field to conserve resources.

Property Of